/*
 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.lang.model.element;

import java.util.List;

import javax.lang.model.type.ExecutableType;
import javax.lang.model.type.NoType;
import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;

/**
 * Represents a method, constructor, or initializer (static or instance) of a
 * class or interface, including annotation type elements.
 * 
 * @author Joseph D. Darcy
 * @author Scott Seligman
 * @author Peter von der Ah&eacute;
 * @see ExecutableType
 * @since 1.6
 */
public interface ExecutableElement extends Element {
	/**
	 * Returns the formal type parameters of this executable in declaration
	 * order.
	 * 
	 * @return the formal type parameters, or an empty list if there are none
	 */
	List<? extends TypeParameterElement> getTypeParameters();

	/**
	 * Returns the return type of this executable. Returns a {@link NoType} with
	 * kind {@link TypeKind#VOID VOID} if this executable is not a method, or is
	 * a method that does not return a value.
	 * 
	 * @return the return type of this executable
	 */
	TypeMirror getReturnType();

	/**
	 * Returns the formal parameters of this executable. They are returned in
	 * declaration order.
	 * 
	 * @return the formal parameters, or an empty list if there are none
	 */
	List<? extends VariableElement> getParameters();

	/**
	 * Returns {@code true} if this method or constructor accepts a variable
	 * number of arguments and returns {@code false} otherwise.
	 * 
	 * @return {@code true} if this method or constructor accepts a variable
	 *         number of arguments and {@code false} otherwise
	 */
	boolean isVarArgs();

	/**
	 * Returns the exceptions and other throwables listed in this method or
	 * constructor's {@code throws} clause in declaration order.
	 * 
	 * @return the exceptions and other throwables listed in the {@code throws}
	 *         clause, or an empty list if there are none
	 */
	List<? extends TypeMirror> getThrownTypes();

	/**
	 * Returns the default value if this executable is an annotation type
	 * element. Returns {@code null} if this method is not an annotation type
	 * element, or if it is an annotation type element with no default value.
	 * 
	 * @return the default value, or {@code null} if none
	 */
	AnnotationValue getDefaultValue();
}
